docs: add a navbar to the webpage#46
Conversation
(and hence manifest.json)
* Show last updated date * Support links to directories * Fix the broken link to the logo
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe PR updates website assets, documentation, and project metadata. Changes include simplified asset paths, enhanced navigation UI, refactored site utilities with helper functions, cross-referenced documentation links, updated FAQ content, and revised package.json metadata including homepage, bugs, and funding URLs. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Heterogeneous changes across multiple file categories require separate reasoning for each cohort. Website refactoring introduces helper utilities and modifies plugin hooks. Documentation changes are primarily link conversions and wording updates. Package metadata changes are straightforward but represent intentional project positioning shifts. Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
.github/site/index.mjs (1)
16-21: Consider simplifying the script tag escape sequence.The
${'</'}script>pattern works but is unusual. Consider using a comment or a more conventional escape method.Apply this diff for a clearer approach:
-const redirectTo = (url) => `Redirecting to ${url}...\n\n<script>\nlocation.href = "${url}"${'</'}script>`; +const redirectTo = (url) => `Redirecting to ${url}...\n\n<script>\nlocation.href = "${url}";<\/script>`;
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
.github/site/coverpage.md(1 hunks).github/site/index.html(1 hunks).github/site/index.mjs(3 hunks)doc/building.md(2 hunks)doc/design.md(6 hunks)doc/faq.md(2 hunks)package.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
doc/design.md
[grammar] ~304-~304: Ensure spelling is correct
Context: ...rtup_*.ts][startupdir] are used at the toplevel modules, namely [background.ts`][backg...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (18)
doc/design.md (4)
177-178: LGTM!Simple and clear addition to the tooling section.
193-195: Cross-references look good.The reference-style links make the documentation more maintainable and enable cross-referencing. Anchors are properly defined.
199-207: Subdirectory references are clear.Using inline links for directory references is pragmatic and readable. No issues here.
363-366: Anchor definitions are complete and well-organized.All four anchors are properly defined and used consistently throughout the document. The reference-style linking enables better documentation maintainability.
.github/site/coverpage.md (1)
2-2: LGTM! Asset path normalized.The removal of the leading
./simplifies the path reference and aligns with the favicon path inindex.html..github/site/index.html (2)
10-10: LGTM! Favicon tag format updated.The non-self-closing format is more standard for HTML5.
14-18: Nav element styling is provided by Docsify—no additional CSS required.The
<nav>element is styled by the external Docsify Vue theme (docsify@4.13.1/lib/themes/vue.min.css), which handles appearance, positioning, and responsive behavior automatically. No custom CSS needs to be added to the repository.Likely an incorrect or invalid review comment.
doc/faq.md (3)
90-90: LGTM! More descriptive explanation.The updated description provides clearer context about External Editor Revived.
95-95: LGTM! Status updated to beta.The maturity status has been updated from "alpha" to "beta", reflecting the project's progress.
109-109: Fragment identifier verified—link is valid.The
#yarn-assetsfragment exists on the target page, anchored to the "Yarn Assets" heading in the README. The link will function correctly.doc/building.md (2)
56-56: LGTM! CI usage clarified.The updated description explicitly mentions CI usage, improving documentation clarity.
114-114: LGTM! Reproducibility note enhanced.The updated note provides a more nuanced explanation of build reproducibility differences between Firefox and Thunderbird add-ons, with clear context about potential future improvements.
package.json (1)
15-17: LGTM! Package metadata enhanced.The homepage has been updated to point to the new GitHub Pages site, and additional public metadata fields (
bugsandfunding) have been added. These changes improve package discoverability and provide clear paths for users to report issues and support the project..github/site/index.mjs (5)
4-4: LGTM! TypeScript checking enabled.Adding
@ts-checkenables type checking in this JavaScript file, improving code quality.
23-37: LGTM! Dynamic footer implementation.The
addFooterfunction provides a clean, centralized way to add footers with back-to-top links and last update information.
45-45: LGTM! Date format configuration added.The
formatUpdatedoption standardizes the date format across the documentation.
54-65: LGTM! Routes refactored to use helper functions.The routes now use the centralized
urlForandredirectTohelpers, improving maintainability.
87-90: LGTM! Plugin updated to use dynamic footer.The plugin now uses the
addFooterhelper for consistent footer injection.
github-project-automation
bot
moved this from 📥️Inbox
to 🪺Experimental
in Ghostbird Issues
1 participant
#5